﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// Reviewed
#pragma once
#include "GcmpModelInterface.h"
#include "IObject.h"
#include "OwnerPtr.h"

namespace gcmp
{
    class IPasteContext;

    /// \brief 粘贴助手接口
    FINAL_INTERFACE class GCMP_MODEL_INTERFACE_EXPORT IPasteHelper : public IObject
    {
    public:
        /// \brief 在Z方向移动
        ///
        /// 竖直方向位移可以从pasteContext中获取。
        /// 先Z方向位移，再XY平面位移。
        ///
        /// \param pasteContext 粘贴上下文
        /// \return bool 移动到了目标位置，返回true；否则返回false
        /// \see IPasteContext
        virtual bool TranslateAlongZDirection(const IPasteContext& pasteContext) = 0;

        /// \brief 在XY平面内移动
        ///
        /// 水平方向位移可以从pasteContext中获取
        /// 先Z方向位移，再XY平面位移。
        // 
        /// \param pasteContext 粘贴上下文
        /// \return bool 移动到了目标位置，返回true；否则返回false
        /// \see IPasteContext
        virtual bool TranslateInXYPlane(const IPasteContext& pasteContext) = 0;

    public:
        /// \brief 创建一个不做任何事情的粘贴助手
        ///
        /// \return OwnerPtr<IPasteHelper> 返回创建出的粘贴助手
        static OwnerPtr<IPasteHelper> CreateDoNothing(void);

    public:
        /// \brief 析构函数
        virtual ~IPasteHelper(void) = 0;
    };
}

